vscode-languageserver-textdocument

What is vscode-languageserver-textdocument?

The vscode-languageserver-textdocument package is designed to provide support for creating and managing text documents in language servers that are compatible with the Language Server Protocol (LSP). This package is particularly useful for developers building extensions for code editors like Visual Studio Code, enabling them to handle text document manipulations and updates efficiently.

What are vscode-languageserver-textdocument's main functionalities?

Text Document Creation

This feature allows the creation of a new text document. The 'create' method takes parameters such as URI, language identifier, version number, and the initial text content of the document.

const { TextDocument } = require('vscode-languageserver-textdocument');
const textDocument = TextDocument.create('uri', 'languageId', 1, 'Initial content of the document.');

Text Document Update

This feature supports updating the content of an existing text document. The 'update' method is used to apply changes to the document, where changes are described in terms of text ranges and new text, and the document version is incremented.

const { TextDocument } = require('vscode-languageserver-textdocument');
const textDocument = TextDocument.create('uri', 'languageId', 1, 'Initial content');
const changes = [{ range: { start: { line: 0, character: 0 }, end: { line: 0, character: 13 } }, text: 'Updated content' }];
textDocument.update(changes, 2);

Other packages similar to vscode-languageserver-textdocument

text-buffer

The 'text-buffer' package provides a powerful API for handling text buffers in Node.js, similar to how vscode-languageserver-textdocument handles text documents. While 'text-buffer' is more general-purpose and not specifically tied to LSP, it offers a broader set of text manipulation capabilities.

monaco-editor

The 'monaco-editor' package is the core editor behind Visual Studio Code, offering rich text editing features. It includes its own model for text handling, which is more integrated with UI components compared to the vscode-languageserver-textdocument that focuses solely on server-side text document management.

README

Text Document implementation for a LSP Node server

Npm module containing a simple text document implementation for Node.js language server

Click here for a detailed document on how to implement language servers for VSCode.

History

1.04

• Introduced ESLint rule for member delimiter style.

1.03

• Moved to ES2020 target and lib

1.0.2

• JSDoc updates

1.0.0

Initial version.

License

MIT